Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add SofaRejectedExecutionHandler for user-customized thread pool #1450

Merged
merged 5 commits into from
Oct 14, 2024

Conversation

bohrqiu
Copy link
Contributor

@bohrqiu bohrqiu commented Oct 3, 2024

Motivation:

The bizExecutor of all servers (TripleServer, httpServer, BoltServer) are configured with SofaRejectedExecutionHandler for exception handling and log processing, but the user-customized thread pool is missing.

Summary by CodeRabbit

  • New Features

    • Introduced a custom handler for managing rejected tasks in the thread pool, improving task execution control.
  • Tests

    • Added a new test to verify the functionality of the rejected execution handler in the thread pool.

Copy link

sofastack-cla bot commented Oct 3, 2024

Hi @bohrqiu, welcome to SOFAStack community, Please sign Contributor License Agreement!

After you signed CLA, we will automatically sync the status of this pull request in 3 minutes.

@sofastack-cla sofastack-cla bot added cla:no Need sign CLA First-time contributor First-time contributor size/S labels Oct 3, 2024
Copy link
Contributor

coderabbitai bot commented Oct 3, 2024

Walkthrough

The changes involve modifications to the UserThreadPool class to implement a custom rejected execution handler for managing tasks that cannot be executed by the thread pool. This is achieved by adding a line in the buildExecutor method. Additionally, a new test method is introduced in the UserThreadPoolManagerTest class to verify the functionality of the new handler, ensuring that the thread pool correctly utilizes the SofaRejectedExecutionHandler.

Changes

File Change Summary
core/api/src/main/java/com/alipay/sofa/rpc/server/UserThreadPool.java Added a custom rejected execution handler in buildExecutor() method.
core/api/src/test/java/com/alipay/sofa/rpc/config/UserThreadPoolManagerTest.java Introduced testRejectedExecutionHandler() to validate the use of SofaRejectedExecutionHandler.

Poem

In the meadow where tasks do play,
A handler's here to save the day!
When threads are full and cannot run,
The Sofa hops in, oh what fun!
With tests to check, all's well and bright,
A bouncy change, a joyful sight! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d36ab09 and b8c1884.

📒 Files selected for processing (1)
  • core/api/src/test/java/com/alipay/sofa/rpc/config/UserThreadPoolManagerTest.java (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • core/api/src/test/java/com/alipay/sofa/rpc/config/UserThreadPoolManagerTest.java

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)
core/api/src/test/java/com/alipay/sofa/rpc/config/UserThreadPoolManagerTest.java (2)

71-77: LGTM: New test method added correctly.

The testRejectedExecutionHandler method effectively verifies that the UserThreadPool uses the SofaRejectedExecutionHandler as intended. This aligns well with the PR objectives.

Consider adding a brief comment explaining the purpose of this test for improved readability:

 @Test
 public void testRejectedExecutionHandler(){
+    // Verify that UserThreadPool uses SofaRejectedExecutionHandler
     UserThreadPool userThreadPool = new UserThreadPool();
     Executor executorService = userThreadPool.getUserExecutor();
     Assert.assertTrue(executorService instanceof ThreadPoolExecutor);
     Assert.assertTrue(((ThreadPoolExecutor) executorService).getRejectedExecutionHandler() instanceof SofaRejectedExecutionHandler);
 }

21-21: Summary: Changes effectively implement and test the new feature.

The addition of the testRejectedExecutionHandler method, along with the necessary import, successfully verifies the implementation of SofaRejectedExecutionHandler for user-customized thread pools. This change aligns well with the PR objectives and enhances the test coverage for the UserThreadPool class.

Consider adding similar tests for other types of user-customized thread pools, if applicable, to ensure comprehensive coverage of the new feature across different scenarios.

Also applies to: 71-77

core/api/src/main/java/com/alipay/sofa/rpc/server/UserThreadPool.java (1)

116-116: LGTM! Consider adding import and updating documentation.

The addition of SofaRejectedExecutionHandler aligns well with the PR objectives and enhances the exception handling for user-customized thread pools. This change is consistent with the existing code structure and doesn't affect the current functionality.

Consider the following suggestions to improve the code further:

  1. Ensure that the SofaRejectedExecutionHandler class is imported at the top of the file if not already present:

    import com.alipay.sofa.rpc.server.SofaRejectedExecutionHandler;
  2. Update the method's documentation to reflect the new behavior:

    /**
     * Builds and configures a ThreadPoolExecutor with custom settings.
     * 
     * @return A configured Executor instance with SofaRejectedExecutionHandler
     */
    protected Executor buildExecutor() {
        // ... existing code ...
    }

These changes will improve code readability and maintainability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 90dc97c and 577a0fd.

📒 Files selected for processing (2)
  • core/api/src/main/java/com/alipay/sofa/rpc/server/UserThreadPool.java (1 hunks)
  • core/api/src/test/java/com/alipay/sofa/rpc/config/UserThreadPoolManagerTest.java (2 hunks)
🔇 Additional comments (1)
core/api/src/test/java/com/alipay/sofa/rpc/config/UserThreadPoolManagerTest.java (1)

21-21: LGTM: Import statement added correctly.

The import for SofaRejectedExecutionHandler is necessary for the new test method and is placed appropriately with other imports.

@EvenLjj EvenLjj closed this Oct 8, 2024
@EvenLjj EvenLjj reopened this Oct 8, 2024
@sofastack-cla sofastack-cla bot added the cla:yes CLA is ok label Oct 8, 2024
@EvenLjj
Copy link
Collaborator

EvenLjj commented Oct 8, 2024

image
@bohrqiu Thank for your pr. Pls run mvn clean compile before git commit.

@sofastack-cla sofastack-cla bot removed the cla:no Need sign CLA label Oct 8, 2024
@bohrqiu
Copy link
Contributor Author

bohrqiu commented Oct 8, 2024

@EvenLjj done

@EvenLjj EvenLjj closed this Oct 9, 2024
@EvenLjj EvenLjj reopened this Oct 9, 2024
@EvenLjj
Copy link
Collaborator

EvenLjj commented Oct 9, 2024

@bohrqiu It's still the same problem.

@bohrqiu
Copy link
Contributor Author

bohrqiu commented Oct 9, 2024

@EvenLjj oh sorry, i got it . i had format the code and run mvn clean install -Pci-install -B -U -e && bash ./tools/check_format.sh

Copy link
Collaborator

@EvenLjj EvenLjj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Lo1nt Lo1nt merged commit b7f0281 into sofastack:master Oct 14, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla:yes CLA is ok First-time contributor First-time contributor size/S
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants